<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">

<title>class RDoc::CrossReference - rdoc: Ruby Standard Library Documentation</title>


<script src="../js/navigation.js" defer></script>
<script src="../js/search.js" defer></script>
<script src="../js/search_index.js" defer></script>
<script src="../js/searcher.js" defer></script>
<script src="../js/darkfish.js" defer></script>

<script src="../js/jquery-3.2.0.min.js"></script>

<script src="../js/vue.min.js"></script>
<script src="../js/js.cookie.min.js"></script>

<link href="../css/fonts.css" rel="stylesheet">
<link id='rdoccss' href="../css/rdoc.css" rel="stylesheet">
<link href="../css/carbon17.css" rel="stylesheet">

<script type="text/javascript">
  var rdoc_rel_prefix = "../";
  var index_rel_prefix = "../";
  var darkModeCsseHref = "../css/rdoc-dm.css"
  var defaultModeCssHref = "../css/rdoc.css"
  // var cssDarkmode = Cookies.get('darkmode');
  
  if( Cookies.get("darkmode") == "true") {
	$('#rdoccss').attr("href", darkModeCsseHref);
}

//  https://cssdeck.com/blog/simple-jquery-stylesheet-switcher/

document.write('<style type="text/css">body{display:none}</style>');

</script>


</head>
<body id="top" role="document" class="class">
  <!-- this is class.html -->

  <div id='actionbar' >
    <div class='wrapper mdiv'>
      <ul class='grids g0'></ul>
    </div> 
    <!-- VERSION HEADER for 3.3.0.preview2 NOT FOUND -->
  </div> <!-- end action bar -->

  <div class='wrapper hdiv'>

    


    <nav id='vapp' role="navigation">
    <div id="project-navigation">
      <div id="home-section" role="region" title="Quick navigation" class="nav-section">
  <h2><a href="../index.html" rel="home">Home</a></h2>

  <div id="table-of-contents-navigation"  >
    <a href="../table_of_contents.html#pages">Pages</a>
    <a href="../table_of_contents.html#classes">Classes</a>
    <a href="../table_of_contents.html#methods">Methods</a>
  </div>
</div>

      <div id="search-section" role="search" class="project-section initially-hidden">
  <form action="#" method="get" accept-charset="utf-8">
    <div id="search-field-wrapper">
      <input id="search-field" role="combobox" aria-label="Search"
             aria-autocomplete="list" aria-controls="search-results"
             type="text" name="search" placeholder="Search" spellcheck="false"
             title="Type to search, Up and Down to navigate, Enter to load">
    </div>

    <ul id="search-results" aria-label="Search Results"
        aria-busy="false" aria-expanded="false"
        aria-atomic="false" class="initially-hidden"></ul>
  </form>
</div>

    </div>


    

    <button id='toggleThing' @click="toggleNav()" >Show/hide navigation</button>
    <div :class="isOpen ? 'block' : 'hidden' " id='toggleMe'>
      <div id="class-metadata">
        
        
<div id="parent-class-section" class="nav-section">
  <h3>Parent</h3>

  <p class="link"><a href="../Object.html">Object</a>
</div>

        
        
        
<!-- Method Quickref -->
<div id="method-list-section" class="nav-section">
  <h3>Methods</h3>

  <ul class="link-list" role="directory">
    <li ><a href="#method-c-new">::new</a>
    <li ><a href="#method-i-resolve">#resolve</a>
    <li ><a href="#method-i-resolve_method">#resolve_method</a>
  </ul>
</div>

      </div>
     </div>
    </nav>


    <div id='extraz'><div class='adzbox-index'  >
      
     </div>         
    </div>

    <main role="main" aria-labelledby="class-RDoc::CrossReference">
    <h1 id="class-RDoc::CrossReference" class="class">
      class RDoc::CrossReference
    </h1>

    <section class="description">
    
<p><a href="CrossReference.html"><code>RDoc::CrossReference</code></a> is a reusable way to create cross references for names.</p>

    </section>

      <section id="5Buntitled-5D" class="documentation-section">


      <section class="constants-list">
      <header>
      <h3>Constants</h3>
      </header>
      <dl>
          <dt id="ALL_CROSSREF_REGEXP">ALL_CROSSREF_REGEXP
          <dd><p>Version of <a href="CrossReference.html#CROSSREF_REGEXP"><code>CROSSREF_REGEXP</code></a> used when <code>--hyperlink-all</code> is specified.</p>
          <dt id="CLASS_REGEXP_STR">CLASS_REGEXP_STR
          <dd><p>Regular expression to match class references</p>
<ol><li>
<p>There can be a ‘\’ in front of text to suppress the cross-reference</p>
</li><li>
<p>There can be a ‘::’ in front of class names to reference from the top-level namespace.</p>
</li><li>
<p>The method can be followed by parenthesis (not recommended)</p>
</li></ol>
          <dt id="CROSSREF_REGEXP">CROSSREF_REGEXP
          <dd><p>Regular expressions matching text that should potentially have cross-reference links generated are passed to add_regexp_handling. Note that these expressions are meant to pick up text for which cross-references have been suppressed, since the suppression characters are removed by the code that is triggered.</p>
          <dt id="METHOD_ARGS_REGEXP_STR">METHOD_ARGS_REGEXP_STR
          <dd><p>Regular expression to match method arguments.</p>
          <dt id="METHOD_ARG_REGEXP_STR">METHOD_ARG_REGEXP_STR
          <dd><p>Regular expression to match a single method argument.</p>
          <dt id="METHOD_REGEXP_STR">METHOD_REGEXP_STR
          <dd><p>Regular expression to match method references.</p>

<p>See <a href="CrossReference.html#CLASS_REGEXP_STR"><code>CLASS_REGEXP_STR</code></a></p>
        </dl>
        </section>

        <section class="attribute-method-details" class="method-section">
        <header>
        <h3>Attributes</h3>
        </header>

          <div id="attribute-i-seen" class="method-detail">
            <div class="method-heading attribute-method-heading">
              <span class="method-name">seen</span><span
                class="attribute-access-type">[RW]</span>
            </div>

            <div class="method-description">
              <p>Hash of references that have been looked-up to their replacements</p>
              </div>
            </div>
            </section>


                <section id="public-class-5Buntitled-5D-method-details" class="method-section">
                <header>
                <h3>Public Class Methods</h3>
                </header>

                  <div id="method-c-new" class="method-detail ">
                            <div class="method-heading">
                              <span class="method-name">new</span><span
                                class="method-args">(context)</span>
                              <span class="method-click-advice">click to toggle source</span>
                            </div>

                            <div class="method-description">
                              <p>Allows cross-references to be created based on the given <code>context</code> (<a href="Context.html"><code>RDoc::Context</code></a>).</p>

                              <div class="method-source-code" id="new-source">
            <pre><span class="ruby-comment"># File rdoc/cross_reference.rb, line 127</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">initialize</span> <span class="ruby-identifier">context</span>
  <span class="ruby-ivar">@context</span> = <span class="ruby-identifier">context</span>
  <span class="ruby-ivar">@store</span>   = <span class="ruby-identifier">context</span>.<span class="ruby-identifier">store</span>

  <span class="ruby-ivar">@seen</span> = {}
<span class="ruby-keyword">end</span></pre>
                              </div>
                            </div>


                          </div>

                          </section>

                <section id="public-instance-5Buntitled-5D-method-details" class="method-section">
                <header>
                <h3>Public Instance Methods</h3>
                </header>

                  <div id="method-i-resolve" class="method-detail ">
                            <div class="method-heading">
                              <span class="method-name">resolve</span><span
                                class="method-args">(name, text)</span>
                              <span class="method-click-advice">click to toggle source</span>
                            </div>

                            <div class="method-description">
                              <p>Returns a reference to <code>name</code>.</p>

<p>If the reference is found and <code>name</code> is not documented <code>text</code> will be returned.  If <code>name</code> is escaped <code>name</code> is returned.  If <code>name</code> is not found <code>text</code> is returned.</p>

                              <div class="method-source-code" id="resolve-source">
            <pre><span class="ruby-comment"># File rdoc/cross_reference.rb, line 187</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">resolve</span> <span class="ruby-identifier">name</span>, <span class="ruby-identifier">text</span>
  <span class="ruby-keyword">return</span> <span class="ruby-ivar">@seen</span>[<span class="ruby-identifier">name</span>] <span class="ruby-keyword">if</span> <span class="ruby-ivar">@seen</span>.<span class="ruby-identifier">include?</span> <span class="ruby-identifier">name</span>

  <span class="ruby-identifier">ref</span> = <span class="ruby-keyword">case</span> <span class="ruby-identifier">name</span>
        <span class="ruby-keyword">when</span> <span class="ruby-regexp">/^\\(#{CLASS_REGEXP_STR})$/o</span> <span class="ruby-keyword">then</span>
          <span class="ruby-ivar">@context</span>.<span class="ruby-identifier">find_symbol</span> <span class="ruby-node">$1</span>
        <span class="ruby-keyword">else</span>
          <span class="ruby-ivar">@context</span>.<span class="ruby-identifier">find_symbol</span> <span class="ruby-identifier">name</span>
        <span class="ruby-keyword">end</span>

  <span class="ruby-identifier">ref</span> = <span class="ruby-identifier">resolve_method</span> <span class="ruby-identifier">name</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">ref</span>

  <span class="ruby-comment"># Try a page name</span>
  <span class="ruby-identifier">ref</span> = <span class="ruby-ivar">@store</span>.<span class="ruby-identifier">page</span> <span class="ruby-identifier">name</span> <span class="ruby-keyword">if</span> <span class="ruby-keyword">not</span> <span class="ruby-identifier">ref</span> <span class="ruby-keyword">and</span> <span class="ruby-identifier">name</span> <span class="ruby-operator">=~</span> <span class="ruby-regexp">/^[\w.]+$/</span>

  <span class="ruby-identifier">ref</span> = <span class="ruby-keyword">nil</span> <span class="ruby-keyword">if</span> <span class="ruby-constant">RDoc</span><span class="ruby-operator">::</span><span class="ruby-constant">Alias</span> <span class="ruby-operator">===</span> <span class="ruby-identifier">ref</span> <span class="ruby-comment"># external alias, can&#39;t link to it</span>

  <span class="ruby-identifier">out</span> = <span class="ruby-keyword">if</span> <span class="ruby-identifier">name</span> <span class="ruby-operator">==</span> <span class="ruby-string">&#39;\\&#39;</span> <span class="ruby-keyword">then</span>
          <span class="ruby-identifier">name</span>
        <span class="ruby-keyword">elsif</span> <span class="ruby-identifier">name</span> <span class="ruby-operator">=~</span> <span class="ruby-regexp">/^\\/</span> <span class="ruby-keyword">then</span>
          <span class="ruby-comment"># we remove the \ only in front of what we know:</span>
          <span class="ruby-comment"># other backslashes are treated later, only outside of &lt;tt&gt;</span>
          <span class="ruby-identifier">ref</span> <span class="ruby-operator">?</span> <span class="ruby-node">$&#39;</span> <span class="ruby-operator">:</span> <span class="ruby-identifier">name</span>
        <span class="ruby-keyword">elsif</span> <span class="ruby-identifier">ref</span> <span class="ruby-keyword">then</span>
          <span class="ruby-keyword">if</span> <span class="ruby-identifier">ref</span>.<span class="ruby-identifier">display?</span> <span class="ruby-keyword">then</span>
            <span class="ruby-identifier">ref</span>
          <span class="ruby-keyword">else</span>
            <span class="ruby-identifier">text</span>
          <span class="ruby-keyword">end</span>
        <span class="ruby-keyword">else</span>
          <span class="ruby-identifier">text</span>
        <span class="ruby-keyword">end</span>

  <span class="ruby-ivar">@seen</span>[<span class="ruby-identifier">name</span>] = <span class="ruby-identifier">out</span>

  <span class="ruby-identifier">out</span>
<span class="ruby-keyword">end</span></pre>
                              </div>
                            </div>


                          </div>

                  <div id="method-i-resolve_method" class="method-detail ">
                            <div class="method-heading">
                              <span class="method-name">resolve_method</span><span
                                class="method-args">(name)</span>
                              <span class="method-click-advice">click to toggle source</span>
                            </div>

                            <div class="method-description">
                              

                              <div class="method-source-code" id="resolve_method-source">
            <pre><span class="ruby-comment"># File rdoc/cross_reference.rb, line 134</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">resolve_method</span> <span class="ruby-identifier">name</span>
  <span class="ruby-identifier">ref</span> = <span class="ruby-keyword">nil</span>

  <span class="ruby-keyword">if</span> <span class="ruby-regexp">/#{CLASS_REGEXP_STR}([.#]|::)#{METHOD_REGEXP_STR}/o</span> <span class="ruby-operator">=~</span> <span class="ruby-identifier">name</span> <span class="ruby-keyword">then</span>
    <span class="ruby-identifier">type</span> = <span class="ruby-node">$2</span>
    <span class="ruby-keyword">if</span> <span class="ruby-string">&#39;.&#39;</span> <span class="ruby-operator">==</span> <span class="ruby-identifier">type</span> <span class="ruby-comment"># will find either #method or ::method</span>
      <span class="ruby-identifier">method</span> = <span class="ruby-node">$3</span>
    <span class="ruby-keyword">else</span>
      <span class="ruby-identifier">method</span> = <span class="ruby-node">&quot;#{type}#{$3}&quot;</span>
    <span class="ruby-keyword">end</span>
    <span class="ruby-identifier">container</span> = <span class="ruby-ivar">@context</span>.<span class="ruby-identifier">find_symbol_module</span>(<span class="ruby-node">$1</span>)
  <span class="ruby-keyword">elsif</span> <span class="ruby-regexp">/^([.#]|::)#{METHOD_REGEXP_STR}/o</span> <span class="ruby-operator">=~</span> <span class="ruby-identifier">name</span> <span class="ruby-keyword">then</span>
    <span class="ruby-identifier">type</span> = <span class="ruby-node">$1</span>
    <span class="ruby-keyword">if</span> <span class="ruby-string">&#39;.&#39;</span> <span class="ruby-operator">==</span> <span class="ruby-identifier">type</span>
      <span class="ruby-identifier">method</span> = <span class="ruby-node">$2</span>
    <span class="ruby-keyword">else</span>
      <span class="ruby-identifier">method</span> = <span class="ruby-node">&quot;#{type}#{$2}&quot;</span>
    <span class="ruby-keyword">end</span>
    <span class="ruby-identifier">container</span> = <span class="ruby-ivar">@context</span>
  <span class="ruby-keyword">else</span>
    <span class="ruby-identifier">type</span> = <span class="ruby-keyword">nil</span>
    <span class="ruby-identifier">container</span> = <span class="ruby-keyword">nil</span>
  <span class="ruby-keyword">end</span>

  <span class="ruby-keyword">if</span> <span class="ruby-identifier">container</span> <span class="ruby-keyword">then</span>
    <span class="ruby-keyword">unless</span> <span class="ruby-constant">RDoc</span><span class="ruby-operator">::</span><span class="ruby-constant">TopLevel</span> <span class="ruby-operator">===</span> <span class="ruby-identifier">container</span> <span class="ruby-keyword">then</span>
      <span class="ruby-keyword">if</span> <span class="ruby-string">&#39;.&#39;</span> <span class="ruby-operator">==</span> <span class="ruby-identifier">type</span> <span class="ruby-keyword">then</span>
        <span class="ruby-keyword">if</span> <span class="ruby-string">&#39;new&#39;</span> <span class="ruby-operator">==</span> <span class="ruby-identifier">method</span> <span class="ruby-keyword">then</span> <span class="ruby-comment"># AnyClassName.new will be class method</span>
          <span class="ruby-identifier">ref</span> = <span class="ruby-identifier">container</span>.<span class="ruby-identifier">find_local_symbol</span> <span class="ruby-identifier">method</span>
          <span class="ruby-identifier">ref</span> = <span class="ruby-identifier">container</span>.<span class="ruby-identifier">find_ancestor_local_symbol</span> <span class="ruby-identifier">method</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">ref</span>
        <span class="ruby-keyword">else</span>
          <span class="ruby-identifier">ref</span> = <span class="ruby-identifier">container</span>.<span class="ruby-identifier">find_local_symbol</span> <span class="ruby-node">&quot;::#{method}&quot;</span>
          <span class="ruby-identifier">ref</span> = <span class="ruby-identifier">container</span>.<span class="ruby-identifier">find_ancestor_local_symbol</span> <span class="ruby-node">&quot;::#{method}&quot;</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">ref</span>
          <span class="ruby-identifier">ref</span> = <span class="ruby-identifier">container</span>.<span class="ruby-identifier">find_local_symbol</span> <span class="ruby-node">&quot;##{method}&quot;</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">ref</span>
          <span class="ruby-identifier">ref</span> = <span class="ruby-identifier">container</span>.<span class="ruby-identifier">find_ancestor_local_symbol</span> <span class="ruby-node">&quot;##{method}&quot;</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">ref</span>
        <span class="ruby-keyword">end</span>
      <span class="ruby-keyword">else</span>
        <span class="ruby-identifier">ref</span> = <span class="ruby-identifier">container</span>.<span class="ruby-identifier">find_local_symbol</span> <span class="ruby-identifier">method</span>
        <span class="ruby-identifier">ref</span> = <span class="ruby-identifier">container</span>.<span class="ruby-identifier">find_ancestor_local_symbol</span> <span class="ruby-identifier">method</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">ref</span>
      <span class="ruby-keyword">end</span>
    <span class="ruby-keyword">end</span>
  <span class="ruby-keyword">end</span>

  <span class="ruby-identifier">ref</span>
<span class="ruby-keyword">end</span></pre>
                              </div>
                            </div>


                          </div>

                          </section>

              </section>
              </main>



            </div>  <!--  class='wrapper hdiv' -->


<footer id="validator-badges" role="contentinfo">
<p><a href="https://validator.w3.org/check/referer">Validate</a></p>
<p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.4.0.</p>
<p>Based on <a href="https://github.com/ged/darkfish/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.</p>

  
    <p><p><a href="https://ruby-doc.org">Ruby-doc.org</a> is provided by <a href="https://jamesbritt.com">James Britt</a> and <a href="https://neurogami.com">Neurogami</a>.</p><p><a href="https://jamesbritt.bandcamp.com/">Maximum R+D</a>.  </p>
</p>
  
  </footer>

<script type="text/javascript">


  let ads  = $("#carbonads-container").children().detach();


  function swapMode() {
    var cookieName = 'darkmode';
    var cssDarkmode = Cookies.get(cookieName);
    console.log("***** swapMode! " + cssDarkmode + " *****");


    if (cssDarkmode == "true") {
      console.log("We have dark mode, set the css to light ...");
      $('#rdoccss').attr("href", defaultModeCssHref);
      $('#cssSelect').text("Dark mode");
      cssDarkmode = "false";
      console.log("swapMode! Now set cookie to " + cssDarkmode);
      Cookies.set(cookieName, cssDarkmode);

    } else {
      console.log("We not have dark mode, set the css to dark ...");
      $('#rdoccss').attr("href", darkModeCsseHref);
      $('#cssSelect').text("Light mode");
      cssDarkmode = "true";
      console.log("swapMode! Now set cookie to " + cssDarkmode);
      Cookies.set(cookieName, cssDarkmode);

    }

    console.log("  --------------- ");
  }


const vueCssApp = new Vue({
el: '#menubar',
data: {
isDark: false
},
methods: {
toggleClass: function(event){
this.isDark = !this.isDark;
}
}
})

const vueApp = new Vue({
el: '#vapp',
data: { 
isOpen: true
},

mounted() {
this.handleResize();
this.manage_mob_classes();
window.addEventListener('resize', this.handleResize)
//this.isOpen !=  (/Android|webOS|iPhone|iPad|iPod|BlackBerry|IEMobile|Opera Mini/i.test(navigator.userAgent));
},
destroyed() {
window.removeEventListener('resize', this.handleResize)
},
created() {
//manage_mob_classes();
},

methods : {
isMobile() {
  return (/Android|webOS|iPhone|iPad|iPod|BlackBerry|IEMobile|Opera Mini/i.test(navigator.userAgent));
},

  handleResize() {
    if (!this.isMobile()) {
      this.isOpen = window.innerWidth > 800;
    }
  },

  manage_mob_classes() {
    if (/Android|webOS|iPhone|iPad|iPod|BlackBerry|IEMobile|Opera Mini/i.test(navigator.userAgent)) {
      $("nav").addClass("mob_nav");
      $("main").addClass("mob_main");
      $("#extraz").addClass("mob_extraz");
      $("#carbonads-container").addClass("mob_carbonads-container");
      this.isOpen  = false;
    } else {
      $("nav").removeClass("mob_nav") 
        $("main").removeClass("mob_main");
      $("#extraz").removeClass("mob_extraz");
      $("#carbonads-container").removeClass("mob_carbonads-container");
      this.isOpen  = true;
    }
  },

  toggleNav() {
    this.isOpen =! this.isOpen ;
    // alert("Toggle nav!");
    console.log("toggleNav() click: " + this.isOpen );
  }
}
})

$("#carbonads-container").append(ads);


$(function() {

    var darkmode = Cookies.get("darkmode");
    console.log("Document ready: " + darkmode);

    if ( darkmode  == "true" ) {
      $('#cssSelect').text("Light mode");
    } else {
      $('#cssSelect').text("Dark mode");
     }

    $('body').css('display','block');
    });

</script>

    
  </body> 
</html>

